//
//  Copyright (c) 2020 Cristian Ortega Gómez (https://github.com/corteggo)
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//

import Foundation

/// Router authentication handler
@objc public protocol RouterAuthenticationHandler {
    // MARK: - Authentication
    
    /// Gets whether user is authenticated or not
    var isAuthenticated: Bool { get }
    
    /// Logins user
    /// - Parameter completion: Completion handler
    func login(completion: (() -> Void)?)
    
    /// Logouts user
    /// - Parameter completion: Completion handler
    func logout(completion: (() -> Void)?)
    
    /// Gets whether authentication handler can handle given callback URL or not
    /// - Parameter url: URL to be handled
    @objc optional func canHandleCallbackUrl(_ url: URL) -> Bool
    
    /// Handles given callback URL
    /// - Parameter url: URL to be handled
    @objc optional func handleCallbackUrl(_ url: URL)
}
